<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">

<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>SHORTSTACK TYPES</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>

<!--  Generated by Natural Docs, version 1.52 -->
<!--  http://www.naturaldocs.org  -->

<!-- saved from url=(0026)http://www.naturaldocs.org -->




<div id=Content><div class="CSection"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="SHORTSTACK_TYPES"></a>SHORTSTACK TYPES</h1><div class=CBody><p>Definitions of the enumerations and data types required by the ShortStack LonTalk Compact API.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#SHORTSTACK_TYPES" >SHORTSTACK TYPES</a></td><td class=SDescription>Definitions of the enumerations and data types required by the ShortStack LonTalk Compact API.</td></tr><tr class="SSection"><td class=SEntry><a href="#ERROR_CODES" >ERROR CODES</a></td><td class=SDescription>This section details the error code enumerations that can be observed with this API, or the ShortStack 2.1 Micro Server.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Enumerations" >Enumerations</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonSystemError" >LonSystemError</a></td><td class=SDescription>System and Micro Server error codes logged in the Smart Transceiver&rsquo;s error log.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonApiError" >LonApiError</a></td><td class=SDescription>ShortStack LonTalk Compact 2.1 API error codes.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Macros" >Macros</a></td><td class=SDescription></td></tr><tr class="SMacro SIndent2 SMarked"><td class=SEntry><a href="#LON_SUCCESS" >LON_SUCCESS</a></td><td class=SDescription>Use the LON_SUCCESS macro to convert a <a href="#LonApiError" class=LType id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">LonApiError</a> code into a boolean success or failure indicator</td></tr><tr class="SSection"><td class=SEntry><a href="#GENERAL_ENUMERATIONS_AND_TYPES" >GENERAL ENUMERATIONS AND TYPES</a></td><td class=SDescription>This section contains the enumerations and data types used with the ShortStack LonTalk Compact 2.1 API</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Macros" >Macros</a></td><td class=SDescription></td></tr><tr class="SMacro SIndent2 SMarked"><td class=SEntry><a href="#LON_GET_UNSIGNED_WORD,LON_SET_UNSIGNED_WORD" >LON_GET_UNSIGNED_WORD, LON_SET_UNSIGNED_WORD</a></td><td class=SDescription>Converts LonWord into a LonUbits16 and converts a LonUbits16 into a LonWord.</td></tr><tr class="SMacro SIndent2"><td class=SEntry><a href="#LON_GET_SIGNED_WORD,LON_SET_SIGNED_WORD" >LON_GET_SIGNED_WORD, LON_SET_SIGNED_WORD</a></td><td class=SDescription>Converts LonWord into a LonBits16 and converts a LonBits16 into a LonWord.</td></tr><tr class="SMacro SIndent2 SMarked"><td class=SEntry><a href="#LON_GET_UNSIGNED_DOUBLEWORD,LON_SET_UNSIGNED_DOUBLEWORD" >LON_GET_UNSIGNED_DOUBLEWORD, LON_SET_UNSIGNED_DOUBLEWORD</a></td><td class=SDescription>Converts LonDoubleWord into a LonUbits32 and converts a LonUbits32 into a LonDoubleWord.</td></tr><tr class="SMacro SIndent2"><td class=SEntry><a href="#LON_GET_SIGNED_DOUBLEWORD,LON_SET_SIGNED_DOUBLEWORD" >LON_GET_SIGNED_DOUBLEWORD, LON_SET_SIGNED_DOUBLEWORD</a></td><td class=SDescription>Converts LonDoubleWord into a LonBits32 and converts a LonBits32 into a LonDoubleWord.</td></tr><tr class="SMacro SIndent2 SMarked"><td class=SEntry><a href="#LON_GET_ATTRIBUTE,LON_SET_ATTRIBUTE" >LON_GET_ATTRIBUTE, LON_SET_ATTRIBUTE</a></td><td class=SDescription>Gets(sets) attributes from(to) a field by appropriately masking and shifting.</td></tr><tr class="SMacro SIndent2"><td class=SEntry><a href="#LON_LINK_LAYER_PROTOCOL_VERSION" >LON_LINK_LAYER_PROTOCOL_VERSION</a></td><td class=SDescription>The current link layer protocol version as implemented by the API.</td></tr><tr class="SMacro SIndent2 SMarked"><td class=SEntry><a href="#LON_DOMAIN_ID_MAX_LENGTH" >LON_DOMAIN_ID_MAX_LENGTH</a></td><td class=SDescription>Maximum length of the domain identifier, in bytes.</td></tr><tr class="SMacro SIndent2"><td class=SEntry><a href="#LON_AUTHENTICATION_KEY_LENGTH" >LON_AUTHENTICATION_KEY_LENGTH</a></td><td class=SDescription>Length of the authentication key, stored in the domain table (<a href="#LonDomain" class=LType id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">LonDomain</a>).</td></tr><tr class="SMacro SIndent2 SMarked"><td class=SEntry><a href="#LON_PROGRAM_ID_LENGTH" >LON_PROGRAM_ID_LENGTH</a></td><td class=SDescription>Length of the application&rsquo;s program identifier, in bytes.</td></tr><tr class="SMacro SIndent2"><td class=SEntry><a href="#LON_LOCATION_LENGTH" >LON_LOCATION_LENGTH</a></td><td class=SDescription>Length of the location identifier, in bytes.</td></tr><tr class="SMacro SIndent2 SMarked"><td class=SEntry><a href="#LON_UNIQUE_ID_LENGTH" >LON_UNIQUE_ID_LENGTH</a></td><td class=SDescription>Length of the node&rsquo;s unique identifier, in bytes.</td></tr><tr class="SMacro SIndent2"><td class=SEntry><a href="#LON_COMMUNICATIONS_PARAMETER_LENGTH" >LON_COMMUNICATIONS_PARAMETER_LENGTH</a></td><td class=SDescription>Number of communication control bytes.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Types" >Types</a></td><td class=SDescription></td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonTransceiverParameters" >LonTransceiverParameters</a></td><td class=SDescription>Parameters for single-ended and special-purpose mode transceivers.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonUniqueId" >LonUniqueId</a></td><td class=SDescription>Holds the unique ID.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonProgramId" >LonProgramId</a></td><td class=SDescription>Holds the program ID.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonDomainId" >LonDomainId</a></td><td class=SDescription>Holds a single domain identifier.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonAuthenticationKey" >LonAuthenticationKey</a></td><td class=SDescription>Holds a single authentication key.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonLocationId" >LonLocationId</a></td><td class=SDescription>Holds a single location identifier.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonSubnetId" >LonSubnetId</a></td><td class=SDescription>Holds a subnet identifier.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonGroupId" >LonGroupId</a></td><td class=SDescription>Holds a group identifier.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNodeId" >LonNodeId</a></td><td class=SDescription>Holds a node identifier.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Enumerations" >Enumerations</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonNeuronModel" >LonNeuronModel</a></td><td class=SDescription>Neuron Chip and Smart Transceiver model codes.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonNeuronState" >LonNeuronState</a></td><td class=SDescription>Neuron Chip and Smart Transceiver state values.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Macros" >Macros</a></td><td class=SDescription></td></tr><tr class="SMacro SIndent2 SMarked"><td class=SEntry><a href="#LON_NEURON_STATE" >LON_NEURON_STATE</a></td><td class=SDescription>Obtain persistent Neuron state information.</td></tr><tr class="SMacro SIndent2"><td class=SEntry><a href="#LON_NODE_STATE" >LON_NODE_STATE</a></td><td class=SDescription>Extracts state information from <a href="#LonNeuronState" class=LType id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">LonNeuronState</a>.</td></tr><tr class="SMacro SIndent2 SMarked"><td class=SEntry><a href="#LON_NODE_STATE_OFFLINE" >LON_NODE_STATE_OFFLINE</a></td><td class=SDescription>Extracts offline details from <a href="#LonNeuronState" class=LType id=link4 onMouseOver="ShowTip(event, 'tt3', 'link4')" onMouseOut="HideTip('tt3')">LonNeuronState</a>.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Types" >Types</a></td><td class=SDescription></td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNodeState" >LonNodeState</a></td><td class=SDescription>Decodes the node&rsquo;s state.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Enumerations" >Enumerations</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonNodeMode" >LonNodeMode</a></td><td class=SDescription>Control node mode with <a href="#LonNmSetNodeModeRequest" class=LType id=link5 onMouseOver="ShowTip(event, 'tt4', 'link5')" onMouseOut="HideTip('tt4')">LonNmSetNodeModeRequest</a>.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonResetCause" >LonResetCause</a></td><td class=SDescription>Decodes the last reset cause.</td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonAddressType" >LonAddressType</a></td><td class=SDescription>Denotes destination address type.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonRepeatTimer" >LonRepeatTimer</a></td><td class=SDescription>Encoded repeat timer values.</td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonReceiveTimer" >LonReceiveTimer</a></td><td class=SDescription>Encoded receive timer values.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonNonGroupReceiveTimer" >LonNonGroupReceiveTimer</a></td><td class=SDescription>Encoded non-group receive timer values.</td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonTransmitTimer" >LonTransmitTimer</a></td><td class=SDescription>Encoded transmit timer values.</td></tr><tr class="SSection"><td class=SEntry><a href="#ADDRESSING_TYPES" >ADDRESSING TYPES</a></td><td class=SDescription>This section contains definitions used with source addresses, destination addresses, and the address table.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Types" >Types</a></td><td class=SDescription></td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonSendGroup" >LonSendGroup</a></td><td class=SDescription>Destination address type for group addressing.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonSendSubnetNode" >LonSendSubnetNode</a></td><td class=SDescription>Destination address type for subnet/node addressing.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonSendUniqueId" >LonSendUniqueId</a></td><td class=SDescription>Destination address type for Unique ID (Neuron ID) addressing.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonSendBroadcast" >LonSendBroadcast</a></td><td class=SDescription>Destination address type for broadcast addressing.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonSendUnassigned" >LonSendUnassigned</a></td><td class=SDescription>Address format to clear an address table entry.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonSendLocal" >LonSendLocal</a></td><td class=SDescription>Destination address type to address the own node locally with <a href="#LonSendAddress" class=LType id=link6 onMouseOver="ShowTip(event, 'tt5', 'link6')" onMouseOut="HideTip('tt5')">LonSendAddress</a>.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonSendAddress" >LonSendAddress</a></td><td class=SDescription>Union of all possible destination address formats.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonReceiveSubnetNode" >LonReceiveSubnetNode</a></td><td class=SDescription>Received subnet/node ID destination addresses, used with unicast messages.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonReceiveUniqueId" >LonReceiveUniqueId</a></td><td class=SDescription>Received 48-bit unique ID (Neuron ID) destination address.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonReceiveGroup" >LonReceiveGroup</a></td><td class=SDescription>Received a group destination address.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonReceiveBroadcast" >LonReceiveBroadcast</a></td><td class=SDescription>Received a broadcast destination address.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonReceiveDestination" >LonReceiveDestination</a></td><td class=SDescription>Union of all possible address formats for receiving an incoming message.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Enumerations" >Enumerations</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonReceiveDestinationAddressFormat" >LonReceiveDestinationAddressFormat</a></td><td class=SDescription>Encodes the format of the receive address.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Types" >Types</a></td><td class=SDescription></td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonReceiveAddress" >LonReceiveAddress</a></td><td class=SDescription>Receive destination and source address for incoming messages.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonResponseSource" >LonResponseSource</a></td><td class=SDescription>Source address of a response message</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonResponseSubnetNode" >LonResponseSubnetNode</a></td><td class=SDescription>Destination of response to unicast request.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonResponseGroup" >LonResponseGroup</a></td><td class=SDescription>Destination of response to multicast request.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonResponseDestination" >LonResponseDestination</a></td><td class=SDescription>Destination of a response.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonResponseAddress" >LonResponseAddress</a></td><td class=SDescription>Address of incoming response.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonExplicitAddress" >LonExplicitAddress</a></td><td class=SDescription>Holds explicit addressing details, if enabled.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonAddressTableGroup" >LonAddressTableGroup</a></td><td class=SDescription>Holds Group addressing information in the address table (<a href="#LonAddress" class=LType id=link7 onMouseOver="ShowTip(event, 'tt6', 'link7')" onMouseOut="HideTip('tt6')">LonAddress</a>).</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonAddressTableSubnetNode" >LonAddressTableSubnetNode</a></td><td class=SDescription>Holds subnet/node addressing information in the address table (<a href="#LonAddress" class=LType id=link8 onMouseOver="ShowTip(event, 'tt6', 'link8')" onMouseOut="HideTip('tt6')">LonAddress</a>).</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonAddressTableBroadcast" >LonAddressTableBroadcast</a></td><td class=SDescription>Holds broadcast addressing information in the address table (<a href="#LonAddress" class=LType id=link9 onMouseOver="ShowTip(event, 'tt6', 'link9')" onMouseOut="HideTip('tt6')">LonAddress</a>).</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonAddressTableTurnaround" >LonAddressTableTurnaround</a></td><td class=SDescription>Holds turnaround address information in the address table (<a href="#LonAddress" class=LType id=link10 onMouseOver="ShowTip(event, 'tt6', 'link10')" onMouseOut="HideTip('tt6')">LonAddress</a>).</td></tr><tr class="SSection"><td class=SEntry><a href="#SYSTEM_STRUCTURES" >SYSTEM STRUCTURES</a></td><td class=SDescription>This section contains definitions of system resources and structures, such as the domain table or address table formats, and so on.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Types_and_Enumerations" >Types and Enumerations</a></td><td class=SDescription></td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonAddress" >LonAddress</a></td><td class=SDescription>Describes one record of the address table.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonDomainLength" >LonDomainLength</a></td><td class=SDescription>Encodes the length of the domain.</td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonAuthenticationType" >LonAuthenticationType</a></td><td class=SDescription>Denotes the authentication type, used with <a href="#LonDomain" class=LType id=link11 onMouseOver="ShowTip(event, 'tt2', 'link11')" onMouseOut="HideTip('tt2')">LonDomain</a>.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonDomain" >LonDomain</a></td><td class=SDescription>Format for a single domain table record.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNvConfig" >LonNvConfig</a></td><td class=SDescription>The network variable configuration structure.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonAliasConfig" >LonAliasConfig</a></td><td class=SDescription>Defines a network variable alias table record.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonDirectModeTransceiver" >LonDirectModeTransceiver</a></td><td class=SDescription>Holds direct-mode transceiver parameters.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonConfigData" >LonConfigData</a></td><td class=SDescription>The configuration data structure.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonStatus" >LonStatus</a></td><td class=SDescription>Holds node status and statistics.</td></tr><tr class="SSection"><td class=SEntry><a href="#MESSAGE_CODES" >MESSAGE CODES</a></td><td class=SDescription>This section defines message codes and utilities for dealing with message codes.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Enumerations" >Enumerations</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonNmMessageCode" >LonNmMessageCode</a></td><td class=SDescription>Message codes for network management and diagnostic classes of messages</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonInstallCommand" >LonInstallCommand</a></td><td class=SDescription>Extended installation commands for devices that use SI data version 2. </td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonNvInfoType" >LonNvInfoType</a></td><td class=SDescription>Types of network variable information that can be queried using *LonInstallQueryNvInfo. </td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonExpSubcommand" >LonExpSubcommand</a></td><td class=SDescription>Subcommand codes when <b>Command</b> is LonNmExpanded.</td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonNodeInfoType" >LonNodeInfoType</a></td><td class=SDescription>Types of node information that can be queried using <b>LonInstallQueryNodeInfo</b>. </td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonNvOrigin" >LonNvOrigin</a></td><td class=SDescription>Defines the origins of a network variable. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Macros" >Macros</a></td><td class=SDescription></td></tr><tr class="SMacro SIndent2 SMarked"><td class=SEntry><a href="#LON_NM_FAILURE" >LON_NM_FAILURE</a></td><td class=SDescription>Failure response codes for network management and diagnostic classes of messages.</td></tr><tr class="SMacro SIndent2"><td class=SEntry><a href="#LON_NM_SUCCESS" >LON_NM_SUCCESS</a></td><td class=SDescription>Success response codes for network management and diagnostic classes of messages.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Types" >Types</a></td><td class=SDescription></td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonCorrelator" >LonCorrelator</a></td><td class=SDescription>Data structure used for correlating requests and repsonses.</td></tr><tr class="SSection"><td class=SEntry><a href="#APPLICATION_BUFFER_STRUCTURES" >APPLICATION BUFFER STRUCTURES</a></td><td class=SDescription>This section details the application buffer structures for sending and receiving messages to and from a network interface. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Enumerations_and_Types" >Enumerations and Types</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonSmipQueue" >LonSmipQueue</a></td><td class=SDescription>Literals for the queue specifier in <a href="#LonSmipHdr" class=LType id=link12 onMouseOver="ShowTip(event, 'tt7', 'link12')" onMouseOut="HideTip('tt7')">LonSmipHdr</a>.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonSmipCmd" >LonSmipCmd</a></td><td class=SDescription>Literals for the &lsquo;cmd&rsquo; byte of <a href="#LonSmipHdr" class=LType id=link13 onMouseOver="ShowTip(event, 'tt7', 'link13')" onMouseOut="HideTip('tt7')">LonSmipHdr</a></td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonSmipHdr" >LonSmipHdr</a></td><td class=SDescription>Preamble for network interface messages.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonSmipExtHdr" >LonSmipExtHdr</a></td><td class=SDescription>An extended header segment, used with some network interface messages.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonSmipDrvCtrl" >LonSmipDrvCtrl</a></td><td class=SDescription>Additional control data used by the link layer driver. </td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonSmipMsg" >LonSmipMsg</a></td><td class=SDescription>Data structure superset for all link layer data. </td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonUsopCmd" >LonUsopCmd</a></td><td class=SDescription>Literals for the sub-command byte of LonNiUsop command</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonResetNotification" >LonResetNotification</a></td><td class=SDescription>Structure for uplink reset message.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNmNvFetchRequest" >LonNmNvFetchRequest</a></td><td class=SDescription>Message structure for a NV fetch request.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Macros" >Macros</a></td><td class=SDescription></td></tr><tr class="SMacro SIndent2 SMarked"><td class=SEntry><a href="#LON_NV_NAME_LEN" >LON_NV_NAME_LEN</a></td><td class=SDescription>The maximum number of bytes in a network variable name, not including the 0 terminator.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Types_and_Enumerations" >Types and Enumerations</a></td><td class=SDescription></td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNmInstallRequest" >LonNmInstallRequest</a></td><td class=SDescription>Message structure used with <b>LonNmInstall</b> requests.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonNmInstallResponse" >LonNmInstallResponse</a></td><td class=SDescription>Message structure used with <b>LonNmInstall</b> responses.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNmSetNodeModeRequest" >LonNmSetNodeModeRequest</a></td><td class=SDescription>Message structure for standard network management command <b>LonNmSetNodeMode</b>.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonMemoryReadWriteMode" >LonMemoryReadWriteMode</a></td><td class=SDescription>Defines addressing mode for memory read and write request.</td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonMemoryWriteForm" >LonMemoryWriteForm</a></td><td class=SDescription>Defines actions that follow a memory write request.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonNmReadMemoryRequest" >LonNmReadMemoryRequest</a></td><td class=SDescription>Message structure used with the <b>LonNmReadMemory</b> request.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNmWriteMemoryRequest" >LonNmWriteMemoryRequest</a></td><td class=SDescription>Message structure used with the <b>LonNmWriteMemory</b> request.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonApplicationMessageCode" >LonApplicationMessageCode</a></td><td class=SDescription>Message codes used with application messages.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNmQueryDomainRequest" >LonNmQueryDomainRequest</a></td><td class=SDescription>Message structure used with <b>LonNmQueryDomain</b>.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonNmQueryNvAliasRequest" >LonNmQueryNvAliasRequest</a></td><td class=SDescription>Message structure used with <b>LonNmQueryNvConfig</b>.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNmQueryNvConfigRequestExp" >LonNmQueryNvConfigRequestExp</a></td><td class=SDescription>Message structure used with LonNmExpanded, LonExpQueryNvConfig</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonNmQueryAliasConfigRequestExp" >LonNmQueryAliasConfigRequestExp</a></td><td class=SDescription>Message structure used with LonNmExpanded, LonExpQueryAliasConfig</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNmQueryAddressRequest" >LonNmQueryAddressRequest</a></td><td class=SDescription>Message structure used with <b>LonNmQueryAddr</b>.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonNdQueryStatusResponse" >LonNdQueryStatusResponse</a></td><td class=SDescription>Message structure used with responses to <b>LonNdQueryStatus</b>.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNdQueryXcvrResponse" >LonNdQueryXcvrResponse</a></td><td class=SDescription>Message structure used with responses to <b>LonNdQueryXcvr</b>.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonNmQuerySiDataRequest" >LonNmQuerySiDataRequest</a></td><td class=SDescription>Message structure used to receive a request to read the SI/SD data.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNmUpdateAddressRequest" >LonNmUpdateAddressRequest</a></td><td class=SDescription>Message structure used with <b>LonNmUpdateAddr</b> requests.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonNmUpdateNvRequest" >LonNmUpdateNvRequest</a></td><td class=SDescription>Message structure used with <b>LonNmUpdateNv</b> request.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNmUpdateNvConfigRequestExp" >LonNmUpdateNvConfigRequestExp</a></td><td class=SDescription>Message structure used with LonNmExpanded.LonExpUpdateNvConfig.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonNmQueryNvConfigResponseExp" >LonNmQueryNvConfigResponseExp</a></td><td class=SDescription>Message structure used in response to LonNmExpanded.LonExpQueryNvConfig.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNmUpdateAliasRequest" >LonNmUpdateAliasRequest</a></td><td class=SDescription>Message structure used with <b>LonNmUpdateNvConfig</b> request.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonNmUpdateAliasConfigRequestExp" >LonNmUpdateAliasConfigRequestExp</a></td><td class=SDescription>Message structure used with LonNmExpanded.LonExpUpdateAliasConfig.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNmQueryAliasConfigResponseExp" >LonNmQueryAliasConfigResponseExp</a></td><td class=SDescription>Message structure used with LonNmExpanded.LonExpQueryAliasConfig.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonNmUpdateDomainRequest" >LonNmUpdateDomainRequest</a></td><td class=SDescription>Message structure used with the <b>LonNmUpdateDomain</b> request.</td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonServiceType" >LonServiceType</a></td><td class=SDescription>Literals for the service type.</td></tr><tr class="SEnumeration SIndent2"><td class=SEntry><a href="#LonMessageType" >LonMessageType</a></td><td class=SDescription>Literals for &ldquo;msg_type&rdquo; field</td></tr><tr class="SEnumeration SIndent2 SMarked"><td class=SEntry><a href="#LonCompletionCode" >LonCompletionCode</a></td><td class=SDescription>Literals for &lsquo;cmpl_code&rsquo; fields.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonExplicitMessage" >LonExplicitMessage</a></td><td class=SDescription>Link-layer data structure for explicit (=non-NV) messages</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNvMessage" >LonNvMessage</a></td><td class=SDescription>Link-layer data structure for network variable messages</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonSicb" >LonSicb</a></td><td class=SDescription>Serial interface control block</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonTag" >LonTag</a></td><td class=SDescription>Message tag type.</td></tr><tr class="SType SIndent2"><td class=SEntry><a href="#LonSignature" >LonSignature</a></td><td class=SDescription>Application signature type.</td></tr><tr class="SType SIndent2 SMarked"><td class=SEntry><a href="#LonNvDescription" >LonNvDescription</a></td><td class=SDescription>Defines the structure of the nvTable variable.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="ERROR_CODES"></a>ERROR CODES</h2><div class=CBody><p>This section details the error code enumerations that can be observed with this API, or the ShortStack 2.1 Micro Server.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Enumerations" >Enumerations</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonSystemError" >LonSystemError</a></td><td class=SDescription>System and Micro Server error codes logged in the Smart Transceiver&rsquo;s error log.</td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonApiError" >LonApiError</a></td><td class=SDescription>ShortStack LonTalk Compact 2.1 API error codes.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Macros" >Macros</a></td><td class=SDescription></td></tr><tr class="SMacro SIndent1 SMarked"><td class=SEntry><a href="#LON_SUCCESS" >LON_SUCCESS</a></td><td class=SDescription>Use the LON_SUCCESS macro to convert a <a href="#LonApiError" class=LType id=link14 onMouseOver="ShowTip(event, 'tt1', 'link14')" onMouseOut="HideTip('tt1')">LonApiError</a> code into a boolean success or failure indicator</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Enumerations"></a>Enumerations</h3></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonSystemError"></a>LonSystemError</h3><div class=CBody><p>System and Micro Server error codes logged in the Smart Transceiver&rsquo;s error log.</p><p>The codes can be accessed using the Query Status standard network management command.&nbsp;  Starting with release 2.10, the most recent system error code is also reported to the application through the <a href="#LonResetNotification" class=LType id=link15 onMouseOver="ShowTip(event, 'tt8', 'link15')" onMouseOut="HideTip('tt8')">LonResetNotification</a> message.</p><p>The standard system errors range above value 128.&nbsp; Values between 8 and 128 are application-specific (but serious) errors.&nbsp; Values used by the ShortStack Micro Server are also included in the LonSystemError enumeration.&nbsp; Micro Server error logging is not available prior to ShortStack 2.1.&nbsp; The standard system error codes are discussed in the Smart Transceiver literature and in the CEA/EIA 709.1-B protocol specification.</p><p>Previously named nm_error.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonApiError"></a>LonApiError</h3><div class=CBody><p>ShortStack LonTalk Compact 2.1 API error codes.</p><p>This enumeration contains all ShortStack LonTalk Compact 2.1 API error codes, including the code for success <u>LonApiNoError</u>.&nbsp; Use the <a href="#LON_SUCCESS" class=LMacro id=link16 onMouseOver="ShowTip(event, 'tt9', 'link16')" onMouseOut="HideTip('tt9')">LON_SUCCESS</a> macro to determine successful completion of an API function.</p><p>Note that these error codes are internal to the API.</p><p>Previously named api_error_code.</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Macros"></a>Macros</h3></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_SUCCESS"></a>LON_SUCCESS</h3><div class=CBody><p>Use the LON_SUCCESS macro to convert a <a href="#LonApiError" class=LType id=link17 onMouseOver="ShowTip(event, 'tt1', 'link17')" onMouseOut="HideTip('tt1')">LonApiError</a> code into a boolean success or failure indicator</p></div></div></div>

<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="GENERAL_ENUMERATIONS_AND_TYPES"></a>GENERAL ENUMERATIONS AND TYPES</h2><div class=CBody><p>This section contains the enumerations and data types used with the ShortStack LonTalk Compact 2.1 API</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Macros" >Macros</a></td><td class=SDescription></td></tr><tr class="SMacro SIndent1 SMarked"><td class=SEntry><a href="#LON_GET_UNSIGNED_WORD,LON_SET_UNSIGNED_WORD" >LON_GET_UNSIGNED_WORD, LON_SET_UNSIGNED_WORD</a></td><td class=SDescription>Converts LonWord into a LonUbits16 and converts a LonUbits16 into a LonWord.</td></tr><tr class="SMacro SIndent1"><td class=SEntry><a href="#LON_GET_SIGNED_WORD,LON_SET_SIGNED_WORD" >LON_GET_SIGNED_WORD, LON_SET_SIGNED_WORD</a></td><td class=SDescription>Converts LonWord into a LonBits16 and converts a LonBits16 into a LonWord.</td></tr><tr class="SMacro SIndent1 SMarked"><td class=SEntry><a href="#LON_GET_UNSIGNED_DOUBLEWORD,LON_SET_UNSIGNED_DOUBLEWORD" >LON_GET_UNSIGNED_DOUBLEWORD, LON_SET_UNSIGNED_DOUBLEWORD</a></td><td class=SDescription>Converts LonDoubleWord into a LonUbits32 and converts a LonUbits32 into a LonDoubleWord.</td></tr><tr class="SMacro SIndent1"><td class=SEntry><a href="#LON_GET_SIGNED_DOUBLEWORD,LON_SET_SIGNED_DOUBLEWORD" >LON_GET_SIGNED_DOUBLEWORD, LON_SET_SIGNED_DOUBLEWORD</a></td><td class=SDescription>Converts LonDoubleWord into a LonBits32 and converts a LonBits32 into a LonDoubleWord.</td></tr><tr class="SMacro SIndent1 SMarked"><td class=SEntry><a href="#LON_GET_ATTRIBUTE,LON_SET_ATTRIBUTE" >LON_GET_ATTRIBUTE, LON_SET_ATTRIBUTE</a></td><td class=SDescription>Gets(sets) attributes from(to) a field by appropriately masking and shifting.</td></tr><tr class="SMacro SIndent1"><td class=SEntry><a href="#LON_LINK_LAYER_PROTOCOL_VERSION" >LON_LINK_LAYER_PROTOCOL_VERSION</a></td><td class=SDescription>The current link layer protocol version as implemented by the API.</td></tr><tr class="SMacro SIndent1 SMarked"><td class=SEntry><a href="#LON_DOMAIN_ID_MAX_LENGTH" >LON_DOMAIN_ID_MAX_LENGTH</a></td><td class=SDescription>Maximum length of the domain identifier, in bytes.</td></tr><tr class="SMacro SIndent1"><td class=SEntry><a href="#LON_AUTHENTICATION_KEY_LENGTH" >LON_AUTHENTICATION_KEY_LENGTH</a></td><td class=SDescription>Length of the authentication key, stored in the domain table (<a href="#LonDomain" class=LType id=link18 onMouseOver="ShowTip(event, 'tt2', 'link18')" onMouseOut="HideTip('tt2')">LonDomain</a>).</td></tr><tr class="SMacro SIndent1 SMarked"><td class=SEntry><a href="#LON_PROGRAM_ID_LENGTH" >LON_PROGRAM_ID_LENGTH</a></td><td class=SDescription>Length of the application&rsquo;s program identifier, in bytes.</td></tr><tr class="SMacro SIndent1"><td class=SEntry><a href="#LON_LOCATION_LENGTH" >LON_LOCATION_LENGTH</a></td><td class=SDescription>Length of the location identifier, in bytes.</td></tr><tr class="SMacro SIndent1 SMarked"><td class=SEntry><a href="#LON_UNIQUE_ID_LENGTH" >LON_UNIQUE_ID_LENGTH</a></td><td class=SDescription>Length of the node&rsquo;s unique identifier, in bytes.</td></tr><tr class="SMacro SIndent1"><td class=SEntry><a href="#LON_COMMUNICATIONS_PARAMETER_LENGTH" >LON_COMMUNICATIONS_PARAMETER_LENGTH</a></td><td class=SDescription>Number of communication control bytes.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Types" >Types</a></td><td class=SDescription></td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonTransceiverParameters" >LonTransceiverParameters</a></td><td class=SDescription>Parameters for single-ended and special-purpose mode transceivers.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonUniqueId" >LonUniqueId</a></td><td class=SDescription>Holds the unique ID.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonProgramId" >LonProgramId</a></td><td class=SDescription>Holds the program ID.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonDomainId" >LonDomainId</a></td><td class=SDescription>Holds a single domain identifier.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonAuthenticationKey" >LonAuthenticationKey</a></td><td class=SDescription>Holds a single authentication key.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonLocationId" >LonLocationId</a></td><td class=SDescription>Holds a single location identifier.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonSubnetId" >LonSubnetId</a></td><td class=SDescription>Holds a subnet identifier.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonGroupId" >LonGroupId</a></td><td class=SDescription>Holds a group identifier.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNodeId" >LonNodeId</a></td><td class=SDescription>Holds a node identifier.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Enumerations" >Enumerations</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonNeuronModel" >LonNeuronModel</a></td><td class=SDescription>Neuron Chip and Smart Transceiver model codes.</td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonNeuronState" >LonNeuronState</a></td><td class=SDescription>Neuron Chip and Smart Transceiver state values.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Macros" >Macros</a></td><td class=SDescription></td></tr><tr class="SMacro SIndent1 SMarked"><td class=SEntry><a href="#LON_NEURON_STATE" >LON_NEURON_STATE</a></td><td class=SDescription>Obtain persistent Neuron state information.</td></tr><tr class="SMacro SIndent1"><td class=SEntry><a href="#LON_NODE_STATE" >LON_NODE_STATE</a></td><td class=SDescription>Extracts state information from <a href="#LonNeuronState" class=LType id=link19 onMouseOver="ShowTip(event, 'tt3', 'link19')" onMouseOut="HideTip('tt3')">LonNeuronState</a>.</td></tr><tr class="SMacro SIndent1 SMarked"><td class=SEntry><a href="#LON_NODE_STATE_OFFLINE" >LON_NODE_STATE_OFFLINE</a></td><td class=SDescription>Extracts offline details from <a href="#LonNeuronState" class=LType id=link20 onMouseOver="ShowTip(event, 'tt3', 'link20')" onMouseOut="HideTip('tt3')">LonNeuronState</a>.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Types" >Types</a></td><td class=SDescription></td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNodeState" >LonNodeState</a></td><td class=SDescription>Decodes the node&rsquo;s state.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Enumerations" >Enumerations</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonNodeMode" >LonNodeMode</a></td><td class=SDescription>Control node mode with <a href="#LonNmSetNodeModeRequest" class=LType id=link21 onMouseOver="ShowTip(event, 'tt4', 'link21')" onMouseOut="HideTip('tt4')">LonNmSetNodeModeRequest</a>.</td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonResetCause" >LonResetCause</a></td><td class=SDescription>Decodes the last reset cause.</td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonAddressType" >LonAddressType</a></td><td class=SDescription>Denotes destination address type.</td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonRepeatTimer" >LonRepeatTimer</a></td><td class=SDescription>Encoded repeat timer values.</td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonReceiveTimer" >LonReceiveTimer</a></td><td class=SDescription>Encoded receive timer values.</td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonNonGroupReceiveTimer" >LonNonGroupReceiveTimer</a></td><td class=SDescription>Encoded non-group receive timer values.</td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonTransmitTimer" >LonTransmitTimer</a></td><td class=SDescription>Encoded transmit timer values.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Macros"></a>Macros</h3></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_GET_UNSIGNED_WORD,LON_SET_UNSIGNED_WORD"></a>LON_GET_UNSIGNED_WORD, LON_SET_UNSIGNED_WORD</h3><div class=CBody><p>Converts LonWord into a LonUbits16 and converts a LonUbits16 into a LonWord.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_GET_SIGNED_WORD,LON_SET_SIGNED_WORD"></a>LON_GET_SIGNED_WORD, LON_SET_SIGNED_WORD</h3><div class=CBody><p>Converts LonWord into a LonBits16 and converts a LonBits16 into a LonWord.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_GET_UNSIGNED_DOUBLEWORD,LON_SET_UNSIGNED_DOUBLEWORD"></a>LON_GET_UNSIGNED_DOUBLEWORD, LON_SET_UNSIGNED_DOUBLEWORD</h3><div class=CBody><p>Converts LonDoubleWord into a LonUbits32 and converts a LonUbits32 into a LonDoubleWord.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_GET_SIGNED_DOUBLEWORD,LON_SET_SIGNED_DOUBLEWORD"></a>LON_GET_SIGNED_DOUBLEWORD, LON_SET_SIGNED_DOUBLEWORD</h3><div class=CBody><p>Converts LonDoubleWord into a LonBits32 and converts a LonBits32 into a LonDoubleWord.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_GET_ATTRIBUTE,LON_SET_ATTRIBUTE"></a>LON_GET_ATTRIBUTE, LON_SET_ATTRIBUTE</h3><div class=CBody><p>Gets(sets) attributes from(to) a field by appropriately masking and shifting.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_LINK_LAYER_PROTOCOL_VERSION"></a>LON_LINK_LAYER_PROTOCOL_VERSION</h3><div class=CBody><p>The current link layer protocol version as implemented by the API.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_DOMAIN_ID_MAX_LENGTH"></a>LON_DOMAIN_ID_MAX_LENGTH</h3><div class=CBody><p>Maximum length of the domain identifier, in bytes.</p><p>The domain identifier can be zero, one, three, or LON_DOMAIN_ID_MAX_LENGTH (6) bytes long.&nbsp; Space for the largest possible identifier is allocated in various structures and message types.&nbsp; See <a href="#LonDomain" class=LType id=link22 onMouseOver="ShowTip(event, 'tt2', 'link22')" onMouseOut="HideTip('tt2')">LonDomain</a> for the domain table structure.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_AUTHENTICATION_KEY_LENGTH"></a>LON_AUTHENTICATION_KEY_LENGTH</h3><div class=CBody><p>Length of the authentication key, stored in the domain table (<a href="#LonDomain" class=LType id=link23 onMouseOver="ShowTip(event, 'tt2', 'link23')" onMouseOut="HideTip('tt2')">LonDomain</a>).</p><p>Previously named AUTH_KEY_LEN.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_PROGRAM_ID_LENGTH"></a>LON_PROGRAM_ID_LENGTH</h3><div class=CBody><p>Length of the application&rsquo;s program identifier, in bytes.</p><p>Previously named ID_STR_LEN.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_LOCATION_LENGTH"></a>LON_LOCATION_LENGTH</h3><div class=CBody><p>Length of the location identifier, in bytes.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_UNIQUE_ID_LENGTH"></a>LON_UNIQUE_ID_LENGTH</h3><div class=CBody><p>Length of the node&rsquo;s unique identifier, in bytes.</p><p>The Unique ID is typically known as the Neuron ID, referring to the Neuron Chip&rsquo;s or Smart Transceiver&rsquo;s unique ID.&nbsp; Previously named NEURON_ID_LEN.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_COMMUNICATIONS_PARAMETER_LENGTH"></a>LON_COMMUNICATIONS_PARAMETER_LENGTH</h3><div class=CBody><p>Number of communication control bytes.</p><p>Previously named NUM_COMM_PARAMS.</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Types"></a>Types</h3></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonTransceiverParameters"></a>LonTransceiverParameters</h3><div class=CBody><p>Parameters for single-ended and special-purpose mode transceivers.</p><p>See <a href="#LonDirectModeTransceiver" class=LType id=link24 onMouseOver="ShowTip(event, 'tt10', 'link24')" onMouseOut="HideTip('tt10')">LonDirectModeTransceiver</a> for direct-mode transceiver parameters.&nbsp; Previously named xcvr_status_struct.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonUniqueId"></a>LonUniqueId</h3><div class=CBody><p>Holds the unique ID.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonProgramId"></a>LonProgramId</h3><div class=CBody><p>Holds the program ID.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonDomainId"></a>LonDomainId</h3><div class=CBody><p>Holds a single domain identifier.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonAuthenticationKey"></a>LonAuthenticationKey</h3><div class=CBody><p>Holds a single authentication key.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonLocationId"></a>LonLocationId</h3><div class=CBody><p>Holds a single location identifier.</p><p>The location identifier is often referred to as the &ldquo;location string&rdquo;.&nbsp; Note that this is misleading, because this data is not limited to ASCII characters or other similar requirements that could be inferred from the word &ldquo;string&rdquo;.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSubnetId"></a>LonSubnetId</h3><div class=CBody><p>Holds a subnet identifier.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonGroupId"></a>LonGroupId</h3><div class=CBody><p>Holds a group identifier.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNodeId"></a>LonNodeId</h3><div class=CBody><p>Holds a node identifier.</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Enumerations"></a>Enumerations</h3></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonNeuronModel"></a>LonNeuronModel</h3><div class=CBody><p>Neuron Chip and Smart Transceiver model codes.</p><p>This enumeration lists all model codes for Neuron Chips or Smart Transceivers.&nbsp; An FTXL Transceiver has modal code LonNeuron3120E4Code (14).&nbsp; Previously named nm_model_code.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonNeuronState"></a>LonNeuronState</h3><div class=CBody><p>Neuron Chip and Smart Transceiver state values.</p><p>This enumeration contains the values of the Neuron Chip&rsquo;s and Smart Transceiver&rsquo;s state information.&nbsp; To convert the state value returned by the Query Status command to one of these values, use the <a href="#LON_NODE_STATE" class=LMacro id=link25 onMouseOver="ShowTip(event, 'tt11', 'link25')" onMouseOut="HideTip('tt11')">LON_NODE_STATE</a> macro.&nbsp; To test for the offline flag, use the <a href="#LON_NODE_STATE_OFFLINE" class=LMacro id=link26 onMouseOver="ShowTip(event, 'tt12', 'link26')" onMouseOut="HideTip('tt12')">LON_NODE_STATE_OFFLINE</a> macro.&nbsp; Previously named nm_node_state.</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Macros"></a>Macros</h3></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_NEURON_STATE"></a>LON_NEURON_STATE</h3><div class=CBody><p>Obtain persistent Neuron state information.</p><p>Use this macro to obtain the 3-bit Neuron state that is stored in EEPROM.&nbsp; Previously named NEURON_STATE.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_NODE_STATE"></a>LON_NODE_STATE</h3><div class=CBody><p>Extracts state information from <a href="#LonNeuronState" class=LType id=link27 onMouseOver="ShowTip(event, 'tt3', 'link27')" onMouseOut="HideTip('tt3')">LonNeuronState</a>.</p><p>Use this macro to decipher the status information encoded within the <a href="#LonNeuronState" class=LType id=link28 onMouseOver="ShowTip(event, 'tt3', 'link28')" onMouseOut="HideTip('tt3')">LonNeuronState</a> enumeration.&nbsp; Previously named NODE_STATE.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_NODE_STATE_OFFLINE"></a>LON_NODE_STATE_OFFLINE</h3><div class=CBody><p>Extracts offline details from <a href="#LonNeuronState" class=LType id=link29 onMouseOver="ShowTip(event, 'tt3', 'link29')" onMouseOut="HideTip('tt3')">LonNeuronState</a>.</p><p>Use this macro to query the node&rsquo;s offline modes.&nbsp; Previously named NODE_STATE_OFFLINE.</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Types"></a>Types</h3></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNodeState"></a>LonNodeState</h3><div class=CBody><p>Decodes the node&rsquo;s state.</p><p>Previously named nm_node_state.</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Enumerations"></a>Enumerations</h3></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonNodeMode"></a>LonNodeMode</h3><div class=CBody><p>Control node mode with <a href="#LonNmSetNodeModeRequest" class=LType id=link30 onMouseOver="ShowTip(event, 'tt4', 'link30')" onMouseOut="HideTip('tt4')">LonNmSetNodeModeRequest</a>.</p><p>Previously named nm_node_mode.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonResetCause"></a>LonResetCause</h3><div class=CBody><p>Decodes the last reset cause.</p><p>The reset cause can be accessed through the <a href="#LonStatus" class=LType id=link31 onMouseOver="ShowTip(event, 'tt13', 'link31')" onMouseOut="HideTip('tt13')">LonStatus</a> structure.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonAddressType"></a>LonAddressType</h3><div class=CBody><p>Denotes destination address type.</p><p>This enumeration holds the literals for the &lsquo;type&rsquo; field of destination addresses for outgoing messages.&nbsp; Previously named AddrType.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonRepeatTimer"></a>LonRepeatTimer</h3><div class=CBody><p>Encoded repeat timer values.</p><p>This enumeration defines the encoded repeat timer values.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonReceiveTimer"></a>LonReceiveTimer</h3><div class=CBody><p>Encoded receive timer values.</p><p>This enumeration defines the encoded receive timer values used with groups.&nbsp; For the non-group receive timer, see <a href="#LonNonGroupReceiveTimer" class=LType id=link32 onMouseOver="ShowTip(event, 'tt14', 'link32')" onMouseOut="HideTip('tt14')">LonNonGroupReceiveTimer</a>.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonNonGroupReceiveTimer"></a>LonNonGroupReceiveTimer</h3><div class=CBody><p>Encoded non-group receive timer values.</p><p>This enumeration defines the encoded values for the receive timer used with any addressing modes other than groups.&nbsp; For the receive timer used with groups, use <a href="#LonReceiveTimer" class=LType id=link33 onMouseOver="ShowTip(event, 'tt15', 'link33')" onMouseOut="HideTip('tt15')">LonReceiveTimer</a>.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonTransmitTimer"></a>LonTransmitTimer</h3><div class=CBody><p>Encoded transmit timer values.</p><p>This enumeration defines the encoded transmit timer values.</p></div></div></div>

<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="ADDRESSING_TYPES"></a>ADDRESSING TYPES</h2><div class=CBody><p>This section contains definitions used with source addresses, destination addresses, and the address table.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Types" >Types</a></td><td class=SDescription></td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonSendGroup" >LonSendGroup</a></td><td class=SDescription>Destination address type for group addressing.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonSendSubnetNode" >LonSendSubnetNode</a></td><td class=SDescription>Destination address type for subnet/node addressing.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonSendUniqueId" >LonSendUniqueId</a></td><td class=SDescription>Destination address type for Unique ID (Neuron ID) addressing.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonSendBroadcast" >LonSendBroadcast</a></td><td class=SDescription>Destination address type for broadcast addressing.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonSendUnassigned" >LonSendUnassigned</a></td><td class=SDescription>Address format to clear an address table entry.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonSendLocal" >LonSendLocal</a></td><td class=SDescription>Destination address type to address the own node locally with <a href="#LonSendAddress" class=LType id=link34 onMouseOver="ShowTip(event, 'tt5', 'link34')" onMouseOut="HideTip('tt5')">LonSendAddress</a>.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonSendAddress" >LonSendAddress</a></td><td class=SDescription>Union of all possible destination address formats.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonReceiveSubnetNode" >LonReceiveSubnetNode</a></td><td class=SDescription>Received subnet/node ID destination addresses, used with unicast messages.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonReceiveUniqueId" >LonReceiveUniqueId</a></td><td class=SDescription>Received 48-bit unique ID (Neuron ID) destination address.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonReceiveGroup" >LonReceiveGroup</a></td><td class=SDescription>Received a group destination address.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonReceiveBroadcast" >LonReceiveBroadcast</a></td><td class=SDescription>Received a broadcast destination address.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonReceiveDestination" >LonReceiveDestination</a></td><td class=SDescription>Union of all possible address formats for receiving an incoming message.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Enumerations" >Enumerations</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonReceiveDestinationAddressFormat" >LonReceiveDestinationAddressFormat</a></td><td class=SDescription>Encodes the format of the receive address.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Types" >Types</a></td><td class=SDescription></td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonReceiveAddress" >LonReceiveAddress</a></td><td class=SDescription>Receive destination and source address for incoming messages.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonResponseSource" >LonResponseSource</a></td><td class=SDescription>Source address of a response message</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonResponseSubnetNode" >LonResponseSubnetNode</a></td><td class=SDescription>Destination of response to unicast request.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonResponseGroup" >LonResponseGroup</a></td><td class=SDescription>Destination of response to multicast request.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonResponseDestination" >LonResponseDestination</a></td><td class=SDescription>Destination of a response.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonResponseAddress" >LonResponseAddress</a></td><td class=SDescription>Address of incoming response.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonExplicitAddress" >LonExplicitAddress</a></td><td class=SDescription>Holds explicit addressing details, if enabled.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonAddressTableGroup" >LonAddressTableGroup</a></td><td class=SDescription>Holds Group addressing information in the address table (<a href="#LonAddress" class=LType id=link35 onMouseOver="ShowTip(event, 'tt6', 'link35')" onMouseOut="HideTip('tt6')">LonAddress</a>).</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonAddressTableSubnetNode" >LonAddressTableSubnetNode</a></td><td class=SDescription>Holds subnet/node addressing information in the address table (<a href="#LonAddress" class=LType id=link36 onMouseOver="ShowTip(event, 'tt6', 'link36')" onMouseOut="HideTip('tt6')">LonAddress</a>).</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonAddressTableBroadcast" >LonAddressTableBroadcast</a></td><td class=SDescription>Holds broadcast addressing information in the address table (<a href="#LonAddress" class=LType id=link37 onMouseOver="ShowTip(event, 'tt6', 'link37')" onMouseOut="HideTip('tt6')">LonAddress</a>).</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonAddressTableTurnaround" >LonAddressTableTurnaround</a></td><td class=SDescription>Holds turnaround address information in the address table (<a href="#LonAddress" class=LType id=link38 onMouseOver="ShowTip(event, 'tt6', 'link38')" onMouseOut="HideTip('tt6')">LonAddress</a>).</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Types"></a>Types</h3></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSendGroup"></a>LonSendGroup</h3><div class=CBody><p>Destination address type for group addressing.</p><p>Group address structure, used for multicast destination addresses with <a href="#LonSendAddress" class=LType id=link39 onMouseOver="ShowTip(event, 'tt5', 'link39')" onMouseOut="HideTip('tt5')">LonSendAddress</a>.&nbsp; Previously named SendGroup.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSendSubnetNode"></a>LonSendSubnetNode</h3><div class=CBody><p>Destination address type for subnet/node addressing.</p><p>Subnet/Node address structure, used for unicast destination addresses with <a href="#LonSendAddress" class=LType id=link40 onMouseOver="ShowTip(event, 'tt5', 'link40')" onMouseOut="HideTip('tt5')">LonSendAddress</a>.&nbsp; Previously named SendSnode.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSendUniqueId"></a>LonSendUniqueId</h3><div class=CBody><p>Destination address type for Unique ID (Neuron ID) addressing.</p><p>Unique ID (Neuron ID) address structure, used for unicast destination addresses with <a href="#LonSendAddress" class=LType id=link41 onMouseOver="ShowTip(event, 'tt5', 'link41')" onMouseOut="HideTip('tt5')">LonSendAddress</a>.&nbsp; Previously named SendNrnid.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSendBroadcast"></a>LonSendBroadcast</h3><div class=CBody><p>Destination address type for broadcast addressing.</p><p>Broadcst address structure, used for multicast destination addresses with <a href="#LonSendAddress" class=LType id=link42 onMouseOver="ShowTip(event, 'tt5', 'link42')" onMouseOut="HideTip('tt5')">LonSendAddress</a>.&nbsp; Previously named SendBcast.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSendUnassigned"></a>LonSendUnassigned</h3><div class=CBody><p>Address format to clear an address table entry.</p><p>Sets the first 2 bytes of the address table entry to 0.&nbsp; Previously named SendUnassigned.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSendLocal"></a>LonSendLocal</h3><div class=CBody><p>Destination address type to address the own node locally with <a href="#LonSendAddress" class=LType id=link43 onMouseOver="ShowTip(event, 'tt5', 'link43')" onMouseOut="HideTip('tt5')">LonSendAddress</a>.</p><p>Previously named SendLocal.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSendAddress"></a>LonSendAddress</h3><div class=CBody><p>Union of all possible destination address formats.</p><p>Previously named SendAddrDtl.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonReceiveSubnetNode"></a>LonReceiveSubnetNode</h3><div class=CBody><p>Received subnet/node ID destination addresses, used with unicast messages.</p><p>Used with <a href="#LonReceiveDestination" class=LType id=link44 onMouseOver="ShowTip(event, 'tt16', 'link44')" onMouseOut="HideTip('tt16')">LonReceiveDestination</a> and <a href="#LonReceiveAddress" class=LType id=link45 onMouseOver="ShowTip(event, 'tt17', 'link45')" onMouseOut="HideTip('tt17')">LonReceiveAddress</a>.&nbsp; Previously named RcvSnode and RcvSrcAddr.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonReceiveUniqueId"></a>LonReceiveUniqueId</h3><div class=CBody><p>Received 48-bit unique ID (Neuron ID) destination address.</p><p>Used with <a href="#LonReceiveDestination" class=LType id=link46 onMouseOver="ShowTip(event, 'tt16', 'link46')" onMouseOut="HideTip('tt16')">LonReceiveDestination</a>.&nbsp; Previously named RcvNrnid.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonReceiveGroup"></a>LonReceiveGroup</h3><div class=CBody><p>Received a group destination address.</p><p>Used with <a href="#LonReceiveDestination" class=LType id=link47 onMouseOver="ShowTip(event, 'tt16', 'link47')" onMouseOut="HideTip('tt16')">LonReceiveDestination</a>.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonReceiveBroadcast"></a>LonReceiveBroadcast</h3><div class=CBody><p>Received a broadcast destination address.</p><p>Used with <a href="#LonReceiveDestination" class=LType id=link48 onMouseOver="ShowTip(event, 'tt16', 'link48')" onMouseOut="HideTip('tt16')">LonReceiveDestination</a>.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonReceiveDestination"></a>LonReceiveDestination</h3><div class=CBody><p>Union of all possible address formats for receiving an incoming message.</p><p>Previously named RcvDestAddr.</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Enumerations"></a>Enumerations</h3></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonReceiveDestinationAddressFormat"></a>LonReceiveDestinationAddressFormat</h3><div class=CBody><p>Encodes the format of the receive address.</p><p>This enumeration encodes the format of the receive address of an incoming message, allowing to select the corresponding member in &lt;LonReceiveDestinationAddress&gt;.&nbsp; Previously named RcvDstAddrFormat.</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Types"></a>Types</h3></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonReceiveAddress"></a>LonReceiveAddress</h3><div class=CBody><p>Receive destination and source address for incoming messages.</p><p>This structure holds the receive destination address of an incoming message (the address through which the message was received on this node) and the message&rsquo;s source address (where it came from).&nbsp; Previously named RcvAddrDtl.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonResponseSource"></a>LonResponseSource</h3><div class=CBody><p>Source address of a response message</p><p>LonResponseSource holds the source address of a response message.&nbsp; Previously named RespSrcAddr.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonResponseSubnetNode"></a>LonResponseSubnetNode</h3><div class=CBody><p>Destination of response to unicast request.</p><p>Used with <a href="#LonResponseDestination" class=LType id=link49 onMouseOver="ShowTip(event, 'tt18', 'link49')" onMouseOut="HideTip('tt18')">LonResponseDestination</a>.&nbsp; Previously named RespSnode.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonResponseGroup"></a>LonResponseGroup</h3><div class=CBody><p>Destination of response to multicast request.</p><p>Used with <a href="#LonResponseDestination" class=LType id=link50 onMouseOver="ShowTip(event, 'tt18', 'link50')" onMouseOut="HideTip('tt18')">LonResponseDestination</a>.&nbsp; Previously named RespGroup.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonResponseDestination"></a>LonResponseDestination</h3><div class=CBody><p>Destination of a response.</p><p>Previously named RespDestAddr.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonResponseAddress"></a>LonResponseAddress</h3><div class=CBody><p>Address of incoming response.</p><p>Previously named RespAddrDtl.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonExplicitAddress"></a>LonExplicitAddress</h3><div class=CBody><p>Holds explicit addressing details, if enabled.</p><p>LonExplicitAddress holds the address details.&nbsp; To access these fields, support for explicit addressing must be enabled.&nbsp; Previously named ExplicitAddr.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonAddressTableGroup"></a>LonAddressTableGroup</h3><div class=CBody><p>Holds Group addressing information in the address table (<a href="#LonAddress" class=LType id=link51 onMouseOver="ShowTip(event, 'tt6', 'link51')" onMouseOut="HideTip('tt6')">LonAddress</a>).</p><p>LonAddressTableGroup holds group addressing data in the address table, used for multicast addressing.&nbsp; This structure also defines which group the node belongs to.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonAddressTableSubnetNode"></a>LonAddressTableSubnetNode</h3><div class=CBody><p>Holds subnet/node addressing information in the address table (<a href="#LonAddress" class=LType id=link52 onMouseOver="ShowTip(event, 'tt6', 'link52')" onMouseOut="HideTip('tt6')">LonAddress</a>).</p><p>LonAddressTableSubnetNode holds subnet/node address information in the address table (<a href="#LonAddress" class=LType id=link53 onMouseOver="ShowTip(event, 'tt6', 'link53')" onMouseOut="HideTip('tt6')">LonAddress</a>), used for unicast addressing.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonAddressTableBroadcast"></a>LonAddressTableBroadcast</h3><div class=CBody><p>Holds broadcast addressing information in the address table (<a href="#LonAddress" class=LType id=link54 onMouseOver="ShowTip(event, 'tt6', 'link54')" onMouseOut="HideTip('tt6')">LonAddress</a>).</p><p>LonAddressTableBroadcast holds broadcast addressing information in the address table (<a href="#LonAddress" class=LType id=link55 onMouseOver="ShowTip(event, 'tt6', 'link55')" onMouseOut="HideTip('tt6')">LonAddress</a>), used for multicast accressing.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonAddressTableTurnaround"></a>LonAddressTableTurnaround</h3><div class=CBody><p>Holds turnaround address information in the address table (<a href="#LonAddress" class=LType id=link56 onMouseOver="ShowTip(event, 'tt6', 'link56')" onMouseOut="HideTip('tt6')">LonAddress</a>).</p></div></div></div>

<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="SYSTEM_STRUCTURES"></a>SYSTEM STRUCTURES</h2><div class=CBody><p>This section contains definitions of system resources and structures, such as the domain table or address table formats, and so on.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Types_and_Enumerations" >Types and Enumerations</a></td><td class=SDescription></td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonAddress" >LonAddress</a></td><td class=SDescription>Describes one record of the address table.</td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonDomainLength" >LonDomainLength</a></td><td class=SDescription>Encodes the length of the domain.</td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonAuthenticationType" >LonAuthenticationType</a></td><td class=SDescription>Denotes the authentication type, used with <a href="#LonDomain" class=LType id=link57 onMouseOver="ShowTip(event, 'tt2', 'link57')" onMouseOut="HideTip('tt2')">LonDomain</a>.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonDomain" >LonDomain</a></td><td class=SDescription>Format for a single domain table record.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNvConfig" >LonNvConfig</a></td><td class=SDescription>The network variable configuration structure.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonAliasConfig" >LonAliasConfig</a></td><td class=SDescription>Defines a network variable alias table record.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonDirectModeTransceiver" >LonDirectModeTransceiver</a></td><td class=SDescription>Holds direct-mode transceiver parameters.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonConfigData" >LonConfigData</a></td><td class=SDescription>The configuration data structure.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonStatus" >LonStatus</a></td><td class=SDescription>Holds node status and statistics.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Types_and_Enumerations"></a>Types and Enumerations</h3></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonAddress"></a>LonAddress</h3><div class=CBody><p>Describes one record of the address table.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonDomainLength"></a>LonDomainLength</h3><div class=CBody><p>Encodes the length of the domain.</p><p>This enumeration encodes the length of the domain.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonAuthenticationType"></a>LonAuthenticationType</h3><div class=CBody><p>Denotes the authentication type, used with <a href="#LonDomain" class=LType id=link58 onMouseOver="ShowTip(event, 'tt2', 'link58')" onMouseOut="HideTip('tt2')">LonDomain</a>.</p><p>This enumeration encodes the authentication type.&nbsp; Use with the LON_DOMAIN_AUTHTYPE_* symbols and the <a href="#LonDomain" class=LType id=link59 onMouseOver="ShowTip(event, 'tt2', 'link59')" onMouseOut="HideTip('tt2')">LonDomain</a> type.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonDomain"></a>LonDomain</h3><div class=CBody><p>Format for a single domain table record.</p><p>Previously named domain_struct.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNvConfig"></a>LonNvConfig</h3><div class=CBody><p>The network variable configuration structure.</p><p>IzoT ShortStack expands this data structure with additional fields, required to support an extended address table (EAT).&nbsp; The API always presents this form of the network variable configuration structure, and automatically translates back to the legacy format when used with a Micro Server which does not support EAT.&nbsp; The LonNvConfigNonEat type, defined below, is strictly for internal use within the API implementation.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonAliasConfig"></a>LonAliasConfig</h3><div class=CBody><p>Defines a network variable alias table record.</p><p>IzoT ShortStack expands this data structure with additional fields, required to support an extended address table (EAT).&nbsp; The API always presents this form of the network variable alias data structure, and automatically translates back to the legacy format when used with a Micro Server which does not support EAT.&nbsp; The LonAliasConfigNonEat type, defined below, is strictly for internal use within the API implementation.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonDirectModeTransceiver"></a>LonDirectModeTransceiver</h3><div class=CBody><p>Holds direct-mode transceiver parameters.</p><p>Previously named direct_param_struct.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonConfigData"></a>LonConfigData</h3><div class=CBody><p>The configuration data structure.</p><p>Previously named config_data_struct.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonStatus"></a>LonStatus</h3><div class=CBody><p>Holds node status and statistics.</p><p>Previously named status_struct.</p></div></div></div>

<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="MESSAGE_CODES"></a>MESSAGE CODES</h2><div class=CBody><p>This section defines message codes and utilities for dealing with message codes.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Enumerations" >Enumerations</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonNmMessageCode" >LonNmMessageCode</a></td><td class=SDescription>Message codes for network management and diagnostic classes of messages</td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonInstallCommand" >LonInstallCommand</a></td><td class=SDescription>Extended installation commands for devices that use SI data version 2. </td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonNvInfoType" >LonNvInfoType</a></td><td class=SDescription>Types of network variable information that can be queried using *LonInstallQueryNvInfo. </td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonExpSubcommand" >LonExpSubcommand</a></td><td class=SDescription>Subcommand codes when <b>Command</b> is LonNmExpanded.</td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonNodeInfoType" >LonNodeInfoType</a></td><td class=SDescription>Types of node information that can be queried using <b>LonInstallQueryNodeInfo</b>. </td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonNvOrigin" >LonNvOrigin</a></td><td class=SDescription>Defines the origins of a network variable. </td></tr><tr class="SGroup"><td class=SEntry><a href="#Macros" >Macros</a></td><td class=SDescription></td></tr><tr class="SMacro SIndent1 SMarked"><td class=SEntry><a href="#LON_NM_FAILURE" >LON_NM_FAILURE</a></td><td class=SDescription>Failure response codes for network management and diagnostic classes of messages.</td></tr><tr class="SMacro SIndent1"><td class=SEntry><a href="#LON_NM_SUCCESS" >LON_NM_SUCCESS</a></td><td class=SDescription>Success response codes for network management and diagnostic classes of messages.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Types" >Types</a></td><td class=SDescription></td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonCorrelator" >LonCorrelator</a></td><td class=SDescription>Data structure used for correlating requests and repsonses.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Enumerations"></a>Enumerations</h3></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonNmMessageCode"></a>LonNmMessageCode</h3><div class=CBody><p>Message codes for network management and diagnostic classes of messages</p><p>Previously named NM_message_code.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonInstallCommand"></a>LonInstallCommand</h3><div class=CBody><p>Extended installation commands for devices that use SI data version 2.&nbsp; SI data version 2 is required for any device that supports dynamic network variables.&nbsp; Used by <a href="#LonNmInstallRequest" class=LType id=link60 onMouseOver="ShowTip(event, 'tt19', 'link60')" onMouseOut="HideTip('tt19')">LonNmInstallRequest</a>.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonNvInfoType"></a>LonNvInfoType</h3><div class=CBody><p>Types of network variable information that can be queried using *LonInstallQueryNvInfo.&nbsp; Used by <a href="#LonNmInstallRequest" class=LType id=link61 onMouseOver="ShowTip(event, 'tt19', 'link61')" onMouseOut="HideTip('tt19')">LonNmInstallRequest</a> when <b>Command</b> is set to <b>LonInstallQueryNvInfo</b>.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonExpSubcommand"></a>LonExpSubcommand</h3><div class=CBody><p>Subcommand codes when <b>Command</b> is LonNmExpanded.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonNodeInfoType"></a>LonNodeInfoType</h3><div class=CBody><p>Types of node information that can be queried using <b>LonInstallQueryNodeInfo</b>.&nbsp; Used by <a href="#LonNmInstallRequest" class=LType id=link62 onMouseOver="ShowTip(event, 'tt19', 'link62')" onMouseOut="HideTip('tt19')">LonNmInstallRequest</a> when <b>Command</b> is set to <b>LonInstallQueryNodeInfo</b>.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonNvOrigin"></a>LonNvOrigin</h3><div class=CBody><p>Defines the origins of a network variable.&nbsp;  Use the LON_NV_DESC_ORIGIN_* macros with the <a href="#LonNmInstallResponse" class=LType id=link63 onMouseOver="ShowTip(event, 'tt20', 'link63')" onMouseOut="HideTip('tt20')">LonNmInstallResponse</a> union.</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Macros"></a>Macros</h3></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_NM_FAILURE"></a>LON_NM_FAILURE</h3><div class=CBody><p>Failure response codes for network management and diagnostic classes of messages.</p></div></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_NM_SUCCESS"></a>LON_NM_SUCCESS</h3><div class=CBody><p>Success response codes for network management and diagnostic classes of messages.</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Types"></a>Types</h3></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonCorrelator"></a>LonCorrelator</h3><div class=CBody><p>Data structure used for correlating requests and repsonses.</p><p>LonCorrelator is used to correlate request messages and their responses.</p></div></div></div>

<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="APPLICATION_BUFFER_STRUCTURES"></a>APPLICATION BUFFER STRUCTURES</h2><div class=CBody><p>This section details the application buffer structures for sending and receiving messages to and from a network interface.&nbsp; These structures have up to two parts: the two-byte network interface command, and the optional message payload with the data.</p><p>Network Interface Command (LonSmipHdr): The network interface command is always present.&nbsp; It contains the network interface command and queue specifier.&nbsp;  This is the only field required for most local network interface commands.</p><p>Data (LonMessageData: LonNiResetPayload, LonNiSidataPayload, or union of LonExplicitMessage and LonNvMessage)</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Enumerations_and_Types" >Enumerations and Types</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonSmipQueue" >LonSmipQueue</a></td><td class=SDescription>Literals for the queue specifier in <a href="#LonSmipHdr" class=LType id=link64 onMouseOver="ShowTip(event, 'tt7', 'link64')" onMouseOut="HideTip('tt7')">LonSmipHdr</a>.</td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonSmipCmd" >LonSmipCmd</a></td><td class=SDescription>Literals for the &lsquo;cmd&rsquo; byte of <a href="#LonSmipHdr" class=LType id=link65 onMouseOver="ShowTip(event, 'tt7', 'link65')" onMouseOut="HideTip('tt7')">LonSmipHdr</a></td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonSmipHdr" >LonSmipHdr</a></td><td class=SDescription>Preamble for network interface messages.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonSmipExtHdr" >LonSmipExtHdr</a></td><td class=SDescription>An extended header segment, used with some network interface messages.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonSmipDrvCtrl" >LonSmipDrvCtrl</a></td><td class=SDescription>Additional control data used by the link layer driver. </td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonSmipMsg" >LonSmipMsg</a></td><td class=SDescription>Data structure superset for all link layer data. </td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonUsopCmd" >LonUsopCmd</a></td><td class=SDescription>Literals for the sub-command byte of LonNiUsop command</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonResetNotification" >LonResetNotification</a></td><td class=SDescription>Structure for uplink reset message.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNmNvFetchRequest" >LonNmNvFetchRequest</a></td><td class=SDescription>Message structure for a NV fetch request.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Macros" >Macros</a></td><td class=SDescription></td></tr><tr class="SMacro SIndent1 SMarked"><td class=SEntry><a href="#LON_NV_NAME_LEN" >LON_NV_NAME_LEN</a></td><td class=SDescription>The maximum number of bytes in a network variable name, not including the 0 terminator.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Types_and_Enumerations" >Types and Enumerations</a></td><td class=SDescription></td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNmInstallRequest" >LonNmInstallRequest</a></td><td class=SDescription>Message structure used with <b>LonNmInstall</b> requests.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonNmInstallResponse" >LonNmInstallResponse</a></td><td class=SDescription>Message structure used with <b>LonNmInstall</b> responses.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNmSetNodeModeRequest" >LonNmSetNodeModeRequest</a></td><td class=SDescription>Message structure for standard network management command <b>LonNmSetNodeMode</b>.</td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonMemoryReadWriteMode" >LonMemoryReadWriteMode</a></td><td class=SDescription>Defines addressing mode for memory read and write request.</td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonMemoryWriteForm" >LonMemoryWriteForm</a></td><td class=SDescription>Defines actions that follow a memory write request.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonNmReadMemoryRequest" >LonNmReadMemoryRequest</a></td><td class=SDescription>Message structure used with the <b>LonNmReadMemory</b> request.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNmWriteMemoryRequest" >LonNmWriteMemoryRequest</a></td><td class=SDescription>Message structure used with the <b>LonNmWriteMemory</b> request.</td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonApplicationMessageCode" >LonApplicationMessageCode</a></td><td class=SDescription>Message codes used with application messages.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNmQueryDomainRequest" >LonNmQueryDomainRequest</a></td><td class=SDescription>Message structure used with <b>LonNmQueryDomain</b>.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonNmQueryNvAliasRequest" >LonNmQueryNvAliasRequest</a></td><td class=SDescription>Message structure used with <b>LonNmQueryNvConfig</b>.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNmQueryNvConfigRequestExp" >LonNmQueryNvConfigRequestExp</a></td><td class=SDescription>Message structure used with LonNmExpanded, LonExpQueryNvConfig</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonNmQueryAliasConfigRequestExp" >LonNmQueryAliasConfigRequestExp</a></td><td class=SDescription>Message structure used with LonNmExpanded, LonExpQueryAliasConfig</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNmQueryAddressRequest" >LonNmQueryAddressRequest</a></td><td class=SDescription>Message structure used with <b>LonNmQueryAddr</b>.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonNdQueryStatusResponse" >LonNdQueryStatusResponse</a></td><td class=SDescription>Message structure used with responses to <b>LonNdQueryStatus</b>.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNdQueryXcvrResponse" >LonNdQueryXcvrResponse</a></td><td class=SDescription>Message structure used with responses to <b>LonNdQueryXcvr</b>.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonNmQuerySiDataRequest" >LonNmQuerySiDataRequest</a></td><td class=SDescription>Message structure used to receive a request to read the SI/SD data.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNmUpdateAddressRequest" >LonNmUpdateAddressRequest</a></td><td class=SDescription>Message structure used with <b>LonNmUpdateAddr</b> requests.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonNmUpdateNvRequest" >LonNmUpdateNvRequest</a></td><td class=SDescription>Message structure used with <b>LonNmUpdateNv</b> request.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNmUpdateNvConfigRequestExp" >LonNmUpdateNvConfigRequestExp</a></td><td class=SDescription>Message structure used with LonNmExpanded.LonExpUpdateNvConfig.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonNmQueryNvConfigResponseExp" >LonNmQueryNvConfigResponseExp</a></td><td class=SDescription>Message structure used in response to LonNmExpanded.LonExpQueryNvConfig.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNmUpdateAliasRequest" >LonNmUpdateAliasRequest</a></td><td class=SDescription>Message structure used with <b>LonNmUpdateNvConfig</b> request.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonNmUpdateAliasConfigRequestExp" >LonNmUpdateAliasConfigRequestExp</a></td><td class=SDescription>Message structure used with LonNmExpanded.LonExpUpdateAliasConfig.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNmQueryAliasConfigResponseExp" >LonNmQueryAliasConfigResponseExp</a></td><td class=SDescription>Message structure used with LonNmExpanded.LonExpQueryAliasConfig.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonNmUpdateDomainRequest" >LonNmUpdateDomainRequest</a></td><td class=SDescription>Message structure used with the <b>LonNmUpdateDomain</b> request.</td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonServiceType" >LonServiceType</a></td><td class=SDescription>Literals for the service type.</td></tr><tr class="SEnumeration SIndent1"><td class=SEntry><a href="#LonMessageType" >LonMessageType</a></td><td class=SDescription>Literals for &ldquo;msg_type&rdquo; field</td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#LonCompletionCode" >LonCompletionCode</a></td><td class=SDescription>Literals for &lsquo;cmpl_code&rsquo; fields.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonExplicitMessage" >LonExplicitMessage</a></td><td class=SDescription>Link-layer data structure for explicit (=non-NV) messages</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNvMessage" >LonNvMessage</a></td><td class=SDescription>Link-layer data structure for network variable messages</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonSicb" >LonSicb</a></td><td class=SDescription>Serial interface control block</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonTag" >LonTag</a></td><td class=SDescription>Message tag type.</td></tr><tr class="SType SIndent1"><td class=SEntry><a href="#LonSignature" >LonSignature</a></td><td class=SDescription>Application signature type.</td></tr><tr class="SType SIndent1 SMarked"><td class=SEntry><a href="#LonNvDescription" >LonNvDescription</a></td><td class=SDescription>Defines the structure of the nvTable variable.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Enumerations_and_Types"></a>Enumerations and Types</h3></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonSmipQueue"></a>LonSmipQueue</h3><div class=CBody><p>Literals for the queue specifier in <a href="#LonSmipHdr" class=LType id=link66 onMouseOver="ShowTip(event, 'tt7', 'link66')" onMouseOut="HideTip('tt7')">LonSmipHdr</a>.</p><p>The queue specifier is OR&rsquo;ed with the <a href="#LonSmipCmd" class=LType id=link67 onMouseOver="ShowTip(event, 'tt21', 'link67')" onMouseOut="HideTip('tt21')">LonSmipCmd</a> for the LonNiComm and LonNiNetManagement commands, and used with the command field of the <a href="#LonSmipHdr" class=LType id=link68 onMouseOver="ShowTip(event, 'tt7', 'link68')" onMouseOut="HideTip('tt7')">LonSmipHdr</a> preamble.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonSmipCmd"></a>LonSmipCmd</h3><div class=CBody><p>Literals for the &lsquo;cmd&rsquo; byte of <a href="#LonSmipHdr" class=LType id=link69 onMouseOver="ShowTip(event, 'tt7', 'link69')" onMouseOut="HideTip('tt7')">LonSmipHdr</a></p><p>These commands are used with the command field of the <a href="#LonSmipHdr" class=LType id=link70 onMouseOver="ShowTip(event, 'tt7', 'link70')" onMouseOut="HideTip('tt7')">LonSmipHdr</a> preamble.&nbsp; Note that the command field may contain significant bits in addition to the values defined with this <a href="#LonSmipCmd" class=LType id=link71 onMouseOver="ShowTip(event, 'tt21', 'link71')" onMouseOut="HideTip('tt21')">LonSmipCmd</a> enumeration.&nbsp; For example, the <a href="#LonSmipQueue" class=LType id=link72 onMouseOver="ShowTip(event, 'tt22', 'link72')" onMouseOut="HideTip('tt22')">LonSmipQueue</a> specifier is OR&rsquo;ed with the LonNiComm and LonNiNetManagement commands.&nbsp; See the definitions of the individual commands in this enumeration for more.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSmipHdr"></a>LonSmipHdr</h3><div class=CBody><p>Preamble for network interface messages.</p><p>The preamble (header) has a length field which specifies the message payload to follow a network interface command, not including the preamble bytes themselves.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSmipExtHdr"></a>LonSmipExtHdr</h3><div class=CBody><p>An extended header segment, used with some network interface messages.</p><p>The info segment is sent after the header and before the payload, each with its own handshake exchange, with outgoing network variable messages related to network variables with indices</p><blockquote><pre>61.</pre></blockquote></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSmipDrvCtrl"></a>LonSmipDrvCtrl</h3><div class=CBody><p>Additional control data used by the link layer driver.&nbsp; This data is never sent or received across the link layer.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSmipMsg"></a>LonSmipMsg</h3><div class=CBody><p>Data structure superset for all link layer data.&nbsp; Izot ShortStack 4.30 adds additional data to this structure, not all of which is exchanged across the link layer.</p><p>Note this is a superset structure.&nbsp; Allocating memory for this structure will be sufficient to hold any link layer packet, but the packet&rsquo;s header must be examined to determine the payload packet structure, and the packet&rsquo;s actual payload size.</p><p>The extended header segment is listed after the payload segment in order to minimize layout changes caused by the addition of the extended header and driver control segments.&nbsp; Note that the declaration order here does not reflect the chronological order of segment transmission.</p><p>The driver control data is used and managed by the driver.</p><p>The Id number is a quasi-unique identifier for a frame.&nbsp; This is useful to correlate and identify frame reports in log files for trouble-shooting.&nbsp; The LdvAlloc API assigns a new number to every newly allocated frame, ignoring overflow errors.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonUsopCmd"></a>LonUsopCmd</h3><div class=CBody><p>Literals for the sub-command byte of LonNiUsop command</p><p>These commands are used in the first byte of the LonNiUsop command payload.&nbsp; Depending upon the sub-command type, additional data can follow.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonResetNotification"></a>LonResetNotification</h3><div class=CBody><p>Structure for uplink reset message.</p><p>The Micro Server provides an uplink reset notification with every reset.&nbsp; Previously named LonResetMsg.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmNvFetchRequest"></a>LonNmNvFetchRequest</h3><div class=CBody><p>Message structure for a NV fetch request.</p><p>Previously named NM_NV_fetch_request.</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Macros"></a>Macros</h3></div></div>

<div class="CMacro"><div class=CTopic><h3 class=CTitle><a name="LON_NV_NAME_LEN"></a>LON_NV_NAME_LEN</h3><div class=CBody><p>The maximum number of bytes in a network variable name, not including the 0 terminator.</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Types_and_Enumerations"></a>Types and Enumerations</h3></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmInstallRequest"></a>LonNmInstallRequest</h3><div class=CBody><p>Message structure used with <b>LonNmInstall</b> requests.</p><p>Each member of this union contains a <b>Command</b> field (<a href="#LonInstallCommand" class=LType id=link73 onMouseOver="ShowTip(event, 'tt23', 'link73')" onMouseOut="HideTip('tt23')">LonInstallCommand</a>) that specifies the command type.&nbsp;  Even though this structure is defined as a union, the message size should include only the fields required for the particular command type.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmInstallResponse"></a>LonNmInstallResponse</h3><div class=CBody><p>Message structure used with <b>LonNmInstall</b> responses.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmSetNodeModeRequest"></a>LonNmSetNodeModeRequest</h3><div class=CBody><p>Message structure for standard network management command <b>LonNmSetNodeMode</b>.</p><p>Previously named NM_set_node_mode_request.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonMemoryReadWriteMode"></a>LonMemoryReadWriteMode</h3><div class=CBody><p>Defines addressing mode for memory read and write request.</p><p>Previously named nm_mem_mode.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonMemoryWriteForm"></a>LonMemoryWriteForm</h3><div class=CBody><p>Defines actions that follow a memory write request.</p><p>Previously named nm_mem_form.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmReadMemoryRequest"></a>LonNmReadMemoryRequest</h3><div class=CBody><p>Message structure used with the <b>LonNmReadMemory</b> request.</p><p>Previously named NM_read_memory_request.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmWriteMemoryRequest"></a>LonNmWriteMemoryRequest</h3><div class=CBody><p>Message structure used with the <b>LonNmWriteMemory</b> request.</p><p>Note that this structure shows only the message header.&nbsp; The message header is followed by the data to write, which must be <b>count</b> bytes following the field <b>Form</b>.&nbsp; Previously named NM_write_memory_request.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonApplicationMessageCode"></a>LonApplicationMessageCode</h3><div class=CBody><p>Message codes used with application messages.</p><p>Application message codes are in the [LonApplicationMsg, LonForeignMsg] range, but selected values are frequently used and should be avoided: LonApplicationIsi is used by the interoperable self-installation (ISI) protocol, and LonApplicationFtp is used for the interoperable file transfer protocol (FTP).&nbsp; When an application is offline and receives a message in the application code range, it can choose to respond with the correct response, or to respond with LonApplicationIsOffLine to indicate the application state and the unavailability of a regular response.&nbsp; Likewise, when the application receives a meaningful message in the foreign frame code range [LonForeignMsg, LonLastMessageCode], the application may indicate the unavailability of a meaningful response by sending a response with the LonForeignIsOffLine code.</p><p>Previously named _NA_appl_msg_code.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmQueryDomainRequest"></a>LonNmQueryDomainRequest</h3><div class=CBody><p>Message structure used with <b>LonNmQueryDomain</b>.</p><p>Previously named NM_query_domain_request.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmQueryNvAliasRequest"></a>LonNmQueryNvAliasRequest</h3><div class=CBody><p>Message structure used with <b>LonNmQueryNvConfig</b>.</p><p>The Index can either be in the range 0..254 or it can be 255 (escape index).&nbsp; If the latter, the request should also contain the 16-bit index following this escape index.</p><p>This request format is used for targets which do not support an extended address table (EAT).&nbsp; For those which so, see the &lt;LonNmQueryNvConfigRequestEat&gt; and &lt;LonNmQueryAliasConfigRequestEat&gt; definitions.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmQueryNvConfigRequestExp"></a>LonNmQueryNvConfigRequestExp</h3><div class=CBody><p>Message structure used with LonNmExpanded, LonExpQueryNvConfig</p><p>See <a href="#LonNmQueryNvAliasRequest" class=LType id=link74 onMouseOver="ShowTip(event, 'tt24', 'link74')" onMouseOut="HideTip('tt24')">LonNmQueryNvAliasRequest</a> for the classic format.&nbsp; See <a href="#LonNmQueryAliasConfigRequestExp" class=LType id=link75 onMouseOver="ShowTip(event, 'tt25', 'link75')" onMouseOut="HideTip('tt25')">LonNmQueryAliasConfigRequestExp</a> for queries to the alias table.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmQueryAliasConfigRequestExp"></a>LonNmQueryAliasConfigRequestExp</h3><div class=CBody><p>Message structure used with LonNmExpanded, LonExpQueryAliasConfig</p><p>See <a href="#LonNmQueryNvAliasRequest" class=LType id=link76 onMouseOver="ShowTip(event, 'tt24', 'link76')" onMouseOut="HideTip('tt24')">LonNmQueryNvAliasRequest</a> for the classic format.&nbsp; See <a href="#LonNmQueryNvConfigRequestExp" class=LType id=link77 onMouseOver="ShowTip(event, 'tt26', 'link77')" onMouseOut="HideTip('tt26')">LonNmQueryNvConfigRequestExp</a> for queries to the alias table.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmQueryAddressRequest"></a>LonNmQueryAddressRequest</h3><div class=CBody><p>Message structure used with <b>LonNmQueryAddr</b>.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNdQueryStatusResponse"></a>LonNdQueryStatusResponse</h3><div class=CBody><p>Message structure used with responses to <b>LonNdQueryStatus</b>.</p><p>Previously named ND_query_status_response.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNdQueryXcvrResponse"></a>LonNdQueryXcvrResponse</h3><div class=CBody><p>Message structure used with responses to <b>LonNdQueryXcvr</b>.</p><p>Previously named ND_query_xcvr_response.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmQuerySiDataRequest"></a>LonNmQuerySiDataRequest</h3><div class=CBody><p>Message structure used to receive a request to read the SI/SD data.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmUpdateAddressRequest"></a>LonNmUpdateAddressRequest</h3><div class=CBody><p>Message structure used with <b>LonNmUpdateAddr</b> requests.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmUpdateNvRequest"></a>LonNmUpdateNvRequest</h3><div class=CBody><p>Message structure used with <b>LonNmUpdateNv</b> request.</p><p>This structure is used to update the network variable configuration table The structure exists in two forms.&nbsp; If the &lsquo;shortIndex&rsquo; field is in the range 0..254, use the shortForm union member.&nbsp; If the short index equals 255, use the longForm union member and obtain the true index from the longIndex field.&nbsp; Note that the data structure shown is an abstraction; the actual message frame used is the smallest possible.</p><p>This message format is used with targets which do not support an extended address table (EAT).&nbsp; For targets which do support EAT, see <a href="#LonNmUpdateNvConfigRequestExp" class=LType id=link78 onMouseOver="ShowTip(event, 'tt27', 'link78')" onMouseOut="HideTip('tt27')">LonNmUpdateNvConfigRequestExp</a>.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmUpdateNvConfigRequestExp"></a>LonNmUpdateNvConfigRequestExp</h3><div class=CBody><p>Message structure used with LonNmExpanded.LonExpUpdateNvConfig.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmQueryNvConfigResponseExp"></a>LonNmQueryNvConfigResponseExp</h3><div class=CBody><p>Message structure used in response to LonNmExpanded.LonExpQueryNvConfig.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmUpdateAliasRequest"></a>LonNmUpdateAliasRequest</h3><div class=CBody><p>Message structure used with <b>LonNmUpdateNvConfig</b> request.</p><p>This structure is used to update the alias configuration table.&nbsp; The structure exists in two forms.&nbsp; If the &lsquo;shortIndex&rsquo; field is in the range 0..254, use the shortForm union member.&nbsp; If the short index equals 255, use the longForm union member and obtain the true index from the longIndex field.&nbsp; The index sent to the Micro Server should be that of the alias plus the network variable count because the alias table follows the network variable config table and the index continues from that table.&nbsp; Note that the data structure shown is an abstraction; the actual message frame used is the smallest possible.</p><p>This message format is used with targets which do not support an extended address table (EAT).&nbsp; For targets which do support EAT, see <a href="#LonNmUpdateAliasConfigRequestExp" class=LType id=link79 onMouseOver="ShowTip(event, 'tt28', 'link79')" onMouseOut="HideTip('tt28')">LonNmUpdateAliasConfigRequestExp</a>.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmUpdateAliasConfigRequestExp"></a>LonNmUpdateAliasConfigRequestExp</h3><div class=CBody><p>Message structure used with LonNmExpanded.LonExpUpdateAliasConfig.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmQueryAliasConfigResponseExp"></a>LonNmQueryAliasConfigResponseExp</h3><div class=CBody><p>Message structure used with LonNmExpanded.LonExpQueryAliasConfig.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNmUpdateDomainRequest"></a>LonNmUpdateDomainRequest</h3><div class=CBody><p>Message structure used with the <b>LonNmUpdateDomain</b> request.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonServiceType"></a>LonServiceType</h3><div class=CBody><p>Literals for the service type.</p><p>Previously named ServiceType.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonMessageType"></a>LonMessageType</h3><div class=CBody><p>Literals for &ldquo;msg_type&rdquo; field</p><p>Previously named MsgType.</p></div></div></div>

<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="LonCompletionCode"></a>LonCompletionCode</h3><div class=CBody><p>Literals for &lsquo;cmpl_code&rsquo; fields.</p><p>Previously named ComplType.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonExplicitMessage"></a>LonExplicitMessage</h3><div class=CBody><p>Link-layer data structure for explicit (=non-NV) messages</p><p>Previously named ExpMsg.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNvMessage"></a>LonNvMessage</h3><div class=CBody><p>Link-layer data structure for network variable messages</p><p>Previously named NvMsg.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSicb"></a>LonSicb</h3><div class=CBody><p>Serial interface control block</p><p>Message payload structure with niCOMM/niNETMGMT messages.&nbsp; It&rsquo;s a union of LonExplicitMessage and LonNvMessage.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonTag"></a>LonTag</h3><div class=CBody><p>Message tag type.</p><p>Applications using the IzoT Interface Interpreter as a framework generator use this type with declarations of message tags.&nbsp; The framework assigns each tag its unique tag number at initialization time.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonSignature"></a>LonSignature</h3><div class=CBody><p>Application signature type.</p><p>Applications have a unique signature value, compiled by the framework generator tool.&nbsp; The signature value helps the Micro Server detect whether a new application is registering or a previously registered application is re-starting.&nbsp; The signature is also typically use in application-specific handlers for persistent data to ensure that such data is not applied to a different application.</p><p>This type defines the signature type as a 32 bit integer even though some framework generators may not use all 16 bits.&nbsp; The signature is never exchanged over the network, so it is always in host byte order.</p></div></div></div>

<div class="CType"><div class=CTopic><h3 class=CTitle><a name="LonNvDescription"></a>LonNvDescription</h3><div class=CBody><p>Defines the structure of the nvTable variable.</p></div></div></div>

</div><!--Content-->


<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->


<div id=Menu><div class=MEntry><div class=MFile><a href="ldv-h.html">ldv.h</a></div></div><div class=MEntry><div class=MFile><a href="LonPlatform-h.html">LonPlatform.h</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackApi-h.html">SHORTSTACK API</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackIsiApi-h.html">SHORTSTACK ISI API</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackIsiTypes-h.html">SHORTSTACK ISI TYPES</a></div></div><div class=MEntry><div class=MFile id=MSelected>SHORTSTACK TYPES</div></div><div class=MEntry><div class=MFile><a href="ShortStackApi-c.html">ShortStackApi.c</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackHandlers-c.html">ShortStackHandlers.c</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackIsiApi-c.html">ShortStackIsiApi.c</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackIsiHandlers-c.html">ShortStackIsiHandlers.c</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Index</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Macros.html">Macros</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Types.html">Types</a></div></div></div></div></div><script type="text/javascript"><!--
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option  id=MSearchEverything selected value="General">Everything</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Macros">Macros</option><option value="Types">Types</option></select></div></div><!--Menu-->



<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CType>ShortStack LonTalk Compact 2.1 API error codes.</div></div><div class=CToolTip id="tt2"><div class=CType>Format for a single domain table record.</div></div><div class=CToolTip id="tt3"><div class=CType>Neuron Chip and Smart Transceiver state values.</div></div><div class=CToolTip id="tt4"><div class=CType>Message structure for standard network management command <b>LonNmSetNodeMode</b>.</div></div><div class=CToolTip id="tt5"><div class=CType>Union of all possible destination address formats.</div></div><div class=CToolTip id="tt6"><div class=CType>Describes one record of the address table.</div></div><div class=CToolTip id="tt7"><div class=CType>Preamble for network interface messages.</div></div><div class=CToolTip id="tt8"><div class=CType>Structure for uplink reset message.</div></div><div class=CToolTip id="tt9"><div class=CMacro>Use the LON_SUCCESS macro to convert a LonApiError code into a boolean success or failure indicator</div></div><div class=CToolTip id="tt10"><div class=CType>Holds direct-mode transceiver parameters.</div></div><div class=CToolTip id="tt11"><div class=CMacro>Extracts state information from LonNeuronState.</div></div><div class=CToolTip id="tt12"><div class=CMacro>Extracts offline details from LonNeuronState.</div></div><div class=CToolTip id="tt13"><div class=CType>Holds node status and statistics.</div></div><div class=CToolTip id="tt14"><div class=CType>Encoded non-group receive timer values.</div></div><div class=CToolTip id="tt15"><div class=CType>Encoded receive timer values.</div></div><div class=CToolTip id="tt16"><div class=CType>Union of all possible address formats for receiving an incoming message.</div></div><div class=CToolTip id="tt17"><div class=CType>Receive destination and source address for incoming messages.</div></div><div class=CToolTip id="tt18"><div class=CType>Destination of a response.</div></div><div class=CToolTip id="tt19"><div class=CType>Message structure used with <b>LonNmInstall</b> requests.</div></div><div class=CToolTip id="tt20"><div class=CType>Message structure used with <b>LonNmInstall</b> responses.</div></div><div class=CToolTip id="tt21"><div class=CType>Literals for the &lsquo;cmd&rsquo; byte of LonSmipHdr</div></div><div class=CToolTip id="tt22"><div class=CType>Literals for the queue specifier in LonSmipHdr.</div></div><div class=CToolTip id="tt23"><div class=CType>Extended installation commands for devices that use SI data version 2. </div></div><div class=CToolTip id="tt24"><div class=CType>Message structure used with <b>LonNmQueryNvConfig</b>.</div></div><div class=CToolTip id="tt25"><div class=CType>Message structure used with LonNmExpanded, LonExpQueryAliasConfig</div></div><div class=CToolTip id="tt26"><div class=CType>Message structure used with LonNmExpanded, LonExpQueryNvConfig</div></div><div class=CToolTip id="tt27"><div class=CType>Message structure used with LonNmExpanded.LonExpUpdateNvConfig.</div></div><div class=CToolTip id="tt28"><div class=CType>Message structure used with LonNmExpanded.LonExpUpdateAliasConfig.</div></div><!--END_ND_TOOLTIPS-->




<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>


<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>